home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / scanmsgs.arc / SCANMSGS.DOC < prev    next >
Encoding:
Text File  |  1987-10-05  |  10.5 KB  |  279 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                         *******************************
  21.                         *        SCNMSGS  v3.1        *
  22.                         *                             *
  23.                         *    Don LaFontaine 167/151   *
  24.                         *                             *
  25.                         *******************************
  26.  
  27.                           From the people in Net 167
  28.  
  29.                  Bringing you such goodies as OOPS! and STEBBS
  30.  
  31.  
  32.  
  33.            COPYRIGHT (C) 1987,  Don Lafontaine; ALL RIGHTS RESERVED.
  34.  
  35.                                Table of Contents
  36.                                =================
  37.  
  38.  
  39.               Introduction to Scanmsgs........................  2
  40.               Why another mail scanner?.......................  2
  41.  
  42.  
  43.                             Setup and Installation
  44.                             ----------------------
  45.  
  46.               Files needed for installation...................  2
  47.               Setting up your screens.........................  3
  48.               Using Embedded commands.........................  3
  49.               Using the "Install" program.....................  4
  50.               Configuring Scanmsgs for all Systems............  4
  51.  
  52.                               Running Batch files
  53.                               -------------------
  54.  
  55.               Username.bbs....................................  5
  56.               Options and switches............................  5
  57.  
  58.  
  59.                               Coming Attractions
  60.                               ------------------
  61.               Special Thanks..................................  6
  62.               Author's Notes..................................  6
  63.  
  64.  
  65.  
  66.                            Introduction to Scanmsgs
  67.                            ========================
  68.  
  69.  
  70.          This  program  is  a  very fast real time mail scanner. It is
  71.          invoked either from Opus "child spawning"  process  with  the
  72.          use  of  embedded  commands or can be invoked through a batch
  73.          file which gives it the flexibility to be run with most types
  74.          of systems. We assume  you  already  run  a  system  and  are
  75.          familiar  with  batch  files.  If  not, then consult your dos
  76.          manual for details.
  77.  
  78.  
  79.          This program has no need to exit to do an update,it does  all
  80.          it's  scanning  online,  (in  the  message  bases,  not  in a
  81.          compiled dat file). This system runs in ansi or  ascii  modes
  82.          and  will  offer  you  a  number  of modes for operating your
  83.          particular system.
  84.  
  85.  
  86.                            Why another Mail Scanner?
  87.                            =========================
  88.  
  89.          With the complexity of todays BBS systems, there was  a  need
  90.          for a "real time" scanner with the flexibility of providing a
  91.          number  of  operating envoironments. This was originally done
  92.          in an effort to avoid having to exit  for  an  update  as  it
  93.          interfered with other systems operating from within Opus.
  94.  
  95.  
  96.                          Files needed for Installation
  97.                          =============================
  98.  
  99.          To  be  sure you have the right version and the real program,
  100.          be sure these programs are  included  in  with  your  scanner
  101.          system:
  102.  
  103.  
  104.                     Filename        Length  Date      Time
  105.                     --------        ------  ----      ----
  106.                     CHKMAIL.BBS         61  09-15-87  14:00:36
  107.                     CHKMAIL.GBS         49  09-15-87  14:00:44
  108.                     COLOCHEK.BAT       125  09-28-87  10:00:22
  109.                     DOMAIL.BBS          42  09-27-87  18:04:12
  110.                     DOMAIL.GBS          42  09-27-87  18:04:26
  111.                     INSTALL.EXE      33494  09-28-87  10:23:02
  112.                     MONOCHEK.BAT       127  09-28-87  10:00:28
  113.                     SCANMSGS.EXE     11294  09-28-87  10:21:38
  114.                     USERNAME.BBS        19  09-23-87  12:41:16
  115.  
  116.          And,  of course,  this DOC file!
  117.  
  118.  
  119.  
  120.                             Setting up your Screens
  121.                             =======================
  122.  
  123.  
  124.          If you are running an Opus system, you  can  invoke  scanmsgs
  125.          from  a  welcome  or a bulletin screen. I choose the bulletin
  126.          screen as it also gives your users a chance to  go  back  and
  127.          scan  again  from the Main menu. We have included two example
  128.          batch files , one for ANSI, and one for  NON-ANSI.  You  will
  129.          notice  a  fallthrough  with  the  deletion of a file that is
  130.          created called username.bbs. This must be deleted after  each
  131.          caller.  If  not, the file is appended, and the scanners only
  132.          read the first line and would assume  the  wrong  user.  Also
  133.          included are four BBS/GBS files,  CHKMAIL and DOMAIL.
  134.  
  135.          Customize  the  BBS/GBS  or dress them up to suit your system
  136.          any way you feel. The commands that are in these  files  must
  137.          be  in  both  GBS/BBS (or oansi) files. They must also not be
  138.          changed in order as it  will  affect  the  deletion  of  your
  139.          USERNAME.BBS file. You may edit the USERNAME.BBS file to test
  140.          the  scanner  locally  , BUT the format is strict. Be sure to
  141.          include the two leading spaces and a tab at the  end  of  the
  142.          line.
  143.  
  144.  
  145.          For some reason, some Opus systems  send  messages  in  lower
  146.          case names, so ignoring the case was of paramount importance.
  147.  
  148.  
  149.                             Using Embedded Commands
  150.                             =======================
  151.  
  152.  
  153.          Opus utilizes a "child spawning" process,  which  allows  the
  154.          use  of embedded characters or commands as they become in the
  155.          Opus envoironment.
  156.  
  157.          Be sure to include the  following  in  your  WELCOME.GBS  and
  158.          WELCOME.BBS  (or  just  one  with  oansi)  files  in order to
  159.          properly invoke Scanmsgs:
  160.  
  161.                                   ^OSchkmail
  162.  
  163.  
  164.  
  165.                            Using the Install Program
  166.                            =========================
  167.  
  168.          Aaah, the beauty in simplicity.  Simple  type  "Install"  and
  169.          tell  it  which  areas  to scan. This will set up the control
  170.          file needed to run the scanner. Enter the area numbers ,  one
  171.          at a time. When you are done, push enter with no entry .
  172.  
  173.  
  174.  
  175.  
  176.  
  177.                      Configuring Scanmsgs for your system
  178.                      ====================================
  179.  
  180.          This program was intended for use with Opus, but  you  should
  181.          be  able to run it with any system that uses the same type of
  182.          system.bbs file structures, of which there are more and more.
  183.          The batches are all the same, except that you  will  have  to
  184.          open  the  username  file  and  delete it with your operating
  185.          system rather than with embedded commands.  If  such  a  need
  186.          exists,  I  am sure we can talk Don into modifying it to suit
  187.          other systems as well.
  188.  
  189.          (Fine,   I'll make it use LASTUSER.BBS to be FIDO compatible.
  190.          ed.)
  191.  
  192.  
  193.                                  USERNAME.BBS
  194.                                  ============
  195.  
  196.          USERNAME.BBS is a file that is  created  before  SCANMSGS  is
  197.          invoked.   It  is created in the CHKMAIL.BBS/GBS files.  This
  198.          is accomplished by the imbedded command:
  199.  
  200.                             ^OOd:\opus\username.bbs
  201.  
  202.          Which tells OPUS to post the user information into that file.
  203.          You  can  edit  this file to have your name in it to test the
  204.          scanner.  The format is:
  205.  
  206.          * Don Lafontaine^I
  207.  
  208.          You have to stick to this format.
  209.  
  210.                              Options and switches
  211.                              ====================
  212.  
  213.          There are two switches you can use with SCANMSGS, P & C.
  214.  
  215.          The P switch is used to pause between areas
  216.          The C switch is used for ANSI mode.
  217.  
  218.          If you want to invoke  SCANMSGS  in  ANSI  mode,   issue  the
  219.          following:
  220.  
  221.          SCANMSGS C
  222.  
  223.          If you want to pause between areas,  issue:
  224.  
  225.          SCANMSGS P
  226.  
  227.          Of  course,   you  can  intermix  these  two as you wish.  It
  228.          doesn't matter what order you use. For example:
  229.  
  230.                                  SCANMSGS P C
  231.  
  232.                                        &
  233.  
  234.                                  SCANMSGS C P
  235.  
  236.          Will do the same thing.
  237.  
  238.                                 Special Thanks
  239.                                 ==============
  240.  
  241.  
  242.          Thanks are extended to Lynn  Morrison  225/101  for  pointing
  243.          out  that  my  documentation stinks! She re-wrote it, and you
  244.          are now reading it.
  245.  
  246.          Also,   Anthony  Lander 167/141,   author  of  STEBBS   (A   fido-net
  247.          compatible  BBS),   for  helping me out with 'C' programming.
  248.          It is really easy to learn 'C' when you  have  somebody  like
  249.          him around.
  250.  
  251.          And,  you people for taking the time and effort to set up and
  252.          judge  my  stuff.   Keep up the good work,  and send me those
  253.          comments.
  254.  
  255.                                  Authors notes
  256.                                  =============
  257.  
  258.          What started out as an exercise in 'C' programming  sure  has
  259.          become  a  full  time job for me.  The scanner was originally
  260.          written in BASIC to see if it could be  done.   Many  of  you
  261.          tried  it,   but, OPUS is such a memory hog (BASIC too!) that
  262.          it just didn't work out for some of you.  Rob Benner  (148/1)
  263.          pointed  out  that it would never work under DoubleDos,  so a
  264.          reduction in size and memory requirement was in order.  Also,
  265.          running under a 4.77 Mhz. machine was intolerable,  so  speed
  266.          increases were also in order.  What you have here is the next
  267.          generation  scanner,   all issues have been dealt with to the
  268.          best of my abilities.  Of course,   more  modifications  will
  269.          come  up as I tune the software and add features.  I got some
  270.          pretty respectable speed figures running it on an  IBM  AT  6
  271.          Mhz.  Those of you with 10-21 Mhz capabilities should find it
  272.          astoundingly  fast.   Keep those remarks coming,  however bad
  273.          they may be,  and I'll deal with them accordingly.
  274.  
  275.                                    The End
  276.                                    -------
  277.  
  278.  
  279.